Skip to content

doc: recommend node-stress-single-test for flaky tests#64223

Open
trivikr wants to merge 4 commits into
nodejs:mainfrom
trivikr:doc-node-stress-single-test
Open

doc: recommend node-stress-single-test for flaky tests#64223
trivikr wants to merge 4 commits into
nodejs:mainfrom
trivikr:doc-node-stress-single-test

Conversation

@trivikr

@trivikr trivikr commented Jul 1, 2026

Copy link
Copy Markdown
Member

Recommend node-stress-single-test in the collaborator guide and onboarding
docs for validating fixes to flaky tests.

Refs: https://openjs-foundation.slack.com/archives/C03BJP63CH0/p1782716150521499

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 1, 2026
@trivikr trivikr requested review from aduh95, joyeecheung and sxa July 1, 2026 02:35
Add guidance to the collaborator guide and onboarding docs recommending
node-stress-single-test when fixing flaky tests, so contributors verify
stability under repeated runs.

Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
@trivikr trivikr force-pushed the doc-node-stress-single-test branch from f20aca5 to ef9208e Compare July 1, 2026 02:45
@trivikr trivikr added the flaky-test Issues and PRs related to the tests with unstable failures on the CI. label Jul 1, 2026
Comment thread doc/contributing/collaborator-guide.md Outdated
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@trivikr trivikr requested a review from aduh95 July 1, 2026 06:57
@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 1, 2026

@sxa sxa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding the hyperlink in, but approving regardless 👍🏻

Comment thread onboarding.md Outdated
* If you are interested in helping out with CI reliability, check out the
[reliability repository][] and [guide on how to deal with CI flakes][].
[reliability repository][] and [guide on how to deal with CI flakes][]. When
fixing a flaky test, it is recommended to run [`node-stress-single-test`][]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fixing a flaky test, it is recommended to run [`node-stress-single-test`][]
fixing a flaky test, it is recommended to run [`node-stress-single-test`][https://ci.nodejs.org/job/node-stress-single-test]

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioning the hyperlink in the bottom improves the source code readability, right?

It's done twice on line 289 for example.

[reliability repository][] and [guide on how to deal with CI flakes][].

Comment thread onboarding.md Outdated
Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
@trivikr trivikr requested a review from joyeecheung July 1, 2026 16:14
@lpinca

lpinca commented Jul 1, 2026

Copy link
Copy Markdown
Member

It is not very useful if the flaky test is in test/parallel because afaik the job runs the test sequentially.

@trivikr

trivikr commented Jul 1, 2026

Copy link
Copy Markdown
Member Author

It is not very useful if the flaky test is in test/parallel because afaik the job runs the test sequentially.

The node-stress-single-test is still helpful for sequential tests.
Do you have a suggestion on how to phrase it in documentation?

@lpinca

lpinca commented Jul 1, 2026

Copy link
Copy Markdown
Member

How about something like "When fixing a flaky test in test/sequentual, it is recommended to run node-stress-single-test. It is also good for tests in in test/parallel, but not very reliable because the job runs the test sequentially".

@trivikr trivikr removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 1, 2026
Comment thread onboarding.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. flaky-test Issues and PRs related to the tests with unstable failures on the CI.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants